home *** CD-ROM | disk | FTP | other *** search
/ Network Support Library / RoseWare - Network Support Library.iso / apidev / tpapi.exe / DOCS / OLDDOCS.LZH / NWBINDRY.DOC < prev    next >
Text File  |  1992-10-26  |  19KB  |  436 lines
  1.                                BINDERY SERVICES
  2.                                ================
  3.  
  4. -------------------------------------------------------------------------------
  5.  
  6.   AddBinderyObjectToSet (BinderyObjectName : ObjectNameType;
  7.                          BinderyObjectType : OT_BinderyType;
  8.                          PropertyName : PropertyNameType;
  9.                          MemberName : ObjectNameType;
  10.                          MemberType : OT_BinderyType) : WORD;
  11.  
  12.     Adds a bindery object to a set property.
  13.  
  14.     BinderyObjectName (Input)         : name of the bindery object to which a
  15.                                         new member will be added.
  16.  
  17.     BinderyObjectType (Input)         : type of the bindery object to which a
  18.                                         new member will be added.
  19.  
  20.     PropertyName (Input)              : name of the property to which the
  21.                                         member will be added.
  22.  
  23.     MemberName (Input)                : name of the object to be added to the
  24.                                         property.
  25.  
  26.     MemberType (Input)                : type of the object to be added to the
  27.                                         property.
  28.  
  29. -------------------------------------------------------------------------------
  30.  
  31.   ChangeBinderyObjectPassword (BinderyObjectName : ObjectNameType;
  32.                                BinderyObjectType : OT_BinderyType;
  33.                                OldPassword, NewPassword : PasswordType) : WORD;
  34.  
  35.     Changes the password of a bindery object.
  36.     NOTE : DOES NOT WORK WITH ENCRYPTED PW
  37.  
  38.     BinderyObjectName (Input)         : name of the bindery object.
  39.  
  40.     BinderyObjectType (Input)         : type of the bindery object.
  41.  
  42.     OldPassword (Input)               : the object's old password.
  43.  
  44.     NewPassword (Input)               : the object's new password.
  45.  
  46. -------------------------------------------------------------------------------
  47.  
  48.   ChangeBinderyObjectSecurity (BinderyObjectName : ObjectNameType;
  49.                                BinderyObjectType : OT_BinderyType;
  50.                                NewObjectSecurity : BYTE) : WORD;
  51.  
  52.     Allows the supervisor to change the security of a bindery object.
  53.  
  54.     BinderyObjectName (Input)         : name of the bindery object.
  55.  
  56.     BinderyObjectType (Input)         : type of the bindery object.
  57.  
  58.     NewObjectSecurity (Input)         : the read/write access of the object
  59.                                         to other objects.
  60.  
  61. -------------------------------------------------------------------------------
  62.  
  63.   ChangePropertySecurity (BinderyObjectName : ObjectNameType;
  64.                           BinderyObjectType : OT_BinderyType;
  65.                           PropertyName : PropertyNameType;
  66.                           NewPropertySecurity : BYTE) : WORD;
  67.  
  68.     Changes the security of a bindery object's property.
  69.  
  70.     BinderyObjectName (Input)         : name of the bindery object.
  71.  
  72.     BinderyObjectType (Input)         : type of the bindery object.
  73.  
  74.     PropertyName (Input)              : name of the property whose security
  75.                                         will be changed.
  76.  
  77.     NewPropertySecurity (Input)       : the read/write access of the property
  78.                                         to others.
  79.  
  80. -------------------------------------------------------------------------------
  81.  
  82.   CloseBindery : WORD;
  83.  
  84.     Allows the supervisor to close the bindery.
  85.  
  86. -------------------------------------------------------------------------------
  87.  
  88.   CreateBinderyObject (BinderyObjectName : ObjectNameType;
  89.                        BinderyObjectType : OT_BinderyType;
  90.                        ObjectFlags, ObjectSecurity : BYTE) : WORD;
  91.  
  92.     Allows the supervisor to create a bindery object.
  93.  
  94.     BinderyObjectName (Input)         : name of the bindery object to create.
  95.  
  96.     BinderyObjectType (Input)         : type of the bindery object to create.
  97.  
  98.     ObjectFlags (Input)               : indicates whether the object will be
  99.                                         DYNAMIC or STATIC.
  100.  
  101.     ObjectSecurity (Input)            : the read/write access of the object to
  102.                                         other objects.
  103.  
  104. -------------------------------------------------------------------------------
  105.  
  106.   CreateProperty (BinderyObjectName : ObjectNameType;
  107.                   BinderyObjectType : OT_BinderyType;
  108.                   PropertyName : PropertyNameType;
  109.                   PropertyFlags, PropertySecurity : BYTE) : WORD;
  110.  
  111.     Adds a property to a bindery object.
  112.  
  113.     BinderyObjectName (Input)         : name of the bindery object for which
  114.                                         the property is to be created.
  115.  
  116.     BinderyObjectType (Input)         : type of the bindery object.
  117.  
  118.     PropertyName (Input)              : name of the new property.
  119.  
  120.     PropertyFlags (Input)             : indicates whether the property will be
  121.                                         DYNAMIC/STATIC and ITEM/SET.
  122.  
  123.     PropertySecurity (Input)          : read/write access of the property to
  124.                                         others.
  125.  
  126. -------------------------------------------------------------------------------
  127.  
  128.   DeleteBinderyObject (BinderyObjectName : ObjectNameType;
  129.                        BinderyObjectType : OT_BinderyType) : WORD;
  130.  
  131.     Allows the supervisor to delete a bindery object.
  132.  
  133.     BinderyObjectName (Input)         : name of the object to delete.
  134.  
  135.     BinderyObjectType (Input)         : type of the object to delete.
  136.  
  137. -------------------------------------------------------------------------------
  138.  
  139.   DeleteBinderyObjectFromSet (BinderyObjectName : ObjectNameType;
  140.                               BinderyObjectType : OT_BinderyType;
  141.                               PropertyName : PropertyNameType;
  142.                               MemberName : ObjectNameType;
  143.                               MemberType : OT_BinderyType) : WORD;
  144.  
  145.     Deletes a bindery object from a set property.
  146.  
  147.     BinderyObjectName (Input)         : name of the bindery object from which
  148.                                         the member will be deleted.
  149.  
  150.     BinderyObjectType (Input)         : type of the bindery object from which
  151.                                         the member will be deleted.
  152.  
  153.     PropertyName (Input)              : name of the SET property from which the
  154.                                         member will be deleted.
  155.  
  156.     MemberName (Input)                : name of the object to be deleted from
  157.                                         the SET property.
  158.  
  159.     MemberType (Input)                : type of the object to be delete from
  160.                                         the SET property.
  161.  
  162. -------------------------------------------------------------------------------
  163.  
  164.   DeleteProperty (BinderyObjectName : ObjectNameType;
  165.                   BinderyObjectType : OT_BinderyType;
  166.                   PropertyName : PropertyNameType) : WORD;
  167.  
  168.     Deletes properties from a bindery object.
  169.  
  170.     BinderyObjectName (Input)         : name of the bindery object.
  171.  
  172.     BinderyObjectType (Input)         : type of the bindery object.
  173.  
  174.     PropertyName (Input)              : the name of the property to be deleted.
  175.  
  176. -------------------------------------------------------------------------------
  177.  
  178.   GetBinderyAccessLevel (VAR SecurityAccessLevel : BYTE;
  179.                          VAR ObjectID : OT_BinderyID) : WORD;
  180.  
  181.     Returns the requesting workstation's access level to a file server's
  182.     bindery.
  183.  
  184.     SecurityAccessLevel (Output)      : receives the security level the object
  185.                                         has to the bindery.
  186.  
  187.     ObjectID (Output)                 : receives the unique ID of the object.
  188.  
  189. -------------------------------------------------------------------------------
  190.  
  191.   GetBinderyObjectID (BinderyObjectName : ObjectNameType;
  192.                       BinderyObjectType : OT_BinderyType;
  193.                       VAR ObjectID : OT_BinderyID) : WORD;
  194.  
  195.     Returns a bindery object's unique identification number.
  196.  
  197.     BinderyObjectName (Input)         : name of the bindery object for which
  198.                                         the ID is to be returned.
  199.  
  200.     BinderyObjectType (Input)         : type of the bindery object.
  201.  
  202.     ObjectID (Output)                 : receives the unique ID of the object.
  203.  
  204. -------------------------------------------------------------------------------
  205.  
  206.   GetBinderyObjectName (ObjectID : OT_BinderyID;
  207.                         VAR BinderyObjectName : ObjectNameType;
  208.                         VAR BinderyObjectType : OT_BinderyType) : WORD;
  209.  
  210.     Returns the name and type of a bindery object.
  211.  
  212.     ObjectID (Input)                  : the unique ID of the object for which
  213.                                         the name/type is to be returned.
  214.  
  215.     ObjectName (Output)               : receives the object name of the ID.
  216.  
  217.     ObjectType (Output)               : receives the object type of the ID.
  218.  
  219. -------------------------------------------------------------------------------
  220.  
  221.   IsBinderyObjectInSet (BinderyObjectName : ObjectNameType;
  222.                         BinderyObjectType : OT_BinderyType;
  223.                         PropertyName : PropertyNameType;
  224.                         MemberName : ObjectNameType;
  225.                         MemberType : OT_BinderyType) : WORD;
  226.  
  227.     Determines if a bindery object is a member of a set property.
  228.  
  229.     BinderyObjectName (Input)         : name of the bindery object.
  230.  
  231.     BinderyObjectType (Input)         : type of the bindery object.
  232.  
  233.     PropertyName (Input)              : name of the SET property from which the
  234.                                         member will be checked for membership.
  235.  
  236.     MemberName (Input)                : name of the object to be checked for
  237.                                         membership.
  238.  
  239.     MemberType (Input)                : type of the object to be checked for
  240.                                         membership.
  241.  
  242. -------------------------------------------------------------------------------
  243.  
  244.   OpenBindery : WORD;
  245.  
  246.     Allows the supervisor to open the bindery.
  247.  
  248. -------------------------------------------------------------------------------
  249.  
  250.   ReadPropertyValue (BinderyObjectName : ObjectNameType;
  251.                      BinderyObjectType : OT_BinderyType;
  252.                      PropertyName : PropertyNameType; SegmentNumber : WORD;
  253.                      VAR PropertyValue : PropertyValueType;
  254.                      VAR MoreSegments, PropertyFlags : BYTE) : WORD;
  255.  
  256.     Returns the value of a bindery object's item or set property.
  257.  
  258.     BinderyObjectName (Input)         : name of the bindery object.
  259.  
  260.     BinderyObjectType (Input)         : type of the bindery object.
  261.  
  262.     PropertyName (Input)              : name of the property to be read.
  263.  
  264.     SegmentNumber (Input)             : segment number of the property to be
  265.                                         read. (1 = first segment)
  266.  
  267.     PropertyValue (Output)            : receives the data contained in the
  268.                                         property.
  269.  
  270.     MoreSegments (Output)             : receives a flag which indicates whether
  271.                                         the property has more segments.
  272.                                         (0 = no more segments)
  273.                                         (255 = more segments)
  274.  
  275.     PropertyFlags (Output)            : receives the flags of the property,
  276.                                         whether DYNAMIC/STATIC and SET/ITEM.
  277.  
  278. -------------------------------------------------------------------------------
  279.  
  280.   RenameBinderyObject (BinderyObjectName,
  281.                        NewBinderyObjectName : ObjectNameType;
  282.                        BinderyObjectType : OT_BinderyType) : WORD;
  283.  
  284.     Allows the supervisor to rename a bindery object.
  285.  
  286.     BinderyObjectName (Input)         : name of the object to rename.
  287.  
  288.     NewBinderyObjectName (Input)      : the new name of the bindery object.
  289.  
  290.     BinderyObjectType (Input)         : type of the object to rename.
  291.  
  292. -------------------------------------------------------------------------------
  293.  
  294.   ScanBinderyObject (SearchObjectName : ObjectNameType;
  295.                      SearchObjectType : OT_BinderyType;
  296.                      VAR ObjectID : OT_BinderyID;
  297.                      VAR BinderyObjectName : ObjectNameType;
  298.                      VAR BinderyObjectType : OT_BinderyType;
  299.                      VAR ObjectHasProperties, ObjectFlags,
  300.                      ObjectSecurity : BYTE) : WORD;
  301.  
  302.     Scans the bindery for an object.
  303.  
  304.     SearchObjectName (Input)          : name of the object to search for.
  305.                                         wildcards are allowed.
  306.  
  307.     SearchObjectType (Input)          : type of the object to search for.
  308.  
  309.     ObjectID (Input/Output)           : contains the objectID from a previous
  310.                                         search.  Initial search requires -1.
  311.  
  312.     BinderyObjectName (Output)        : contains the name of a matching bindery
  313.                                         object.
  314.  
  315.     BinderyObjectType (Output)        : contains the type of the matching
  316.                                         bindery object.
  317.  
  318.     ObjectHasProperties (Output)      : indicates whether the object has any
  319.                                         properties. (0 = no properties)
  320.                                                     (255 = properties exist)
  321.  
  322.     ObjectFlags (Output)              : indicates whether the object is
  323.                                         DYNAMIC/STATIC.
  324.  
  325.     ObjectSecurity (Output)           : receives a flag that indicates the
  326.                                         read/write access of others to the
  327.                                         object.
  328.  
  329. -------------------------------------------------------------------------------
  330.  
  331.   ScanBinderyObjectTrusteePaths (ObjectID : OT_BinderyID; VolumeNumber : BYTE;
  332.                                  VAR SequenceNumber : WORD;
  333.                                  VAR TrusteeAccessMask : WORD;
  334.                                  VAR TrusteePathName : PathNameType) : WORD;
  335.  
  336.     Returns the directory paths to which an object has trustee rights.
  337.  
  338.     ObjectID (Input)                  : object ID for which trustee info
  339.                                         should be returned.
  340.  
  341.     VolumeNumber (Input)              : the volume to be searched.
  342.  
  343.     SequenceNumber (Input/Output)     : contains the sequence number from a
  344.                                         previous search.  Initial search
  345.                                         requires a 0.
  346.  
  347.     TrusteeAccessMask (Output)        : receives the trustee rights to
  348.                                         TrusteePathName.
  349.  
  350.     TrusteePathName (Output)          : receives a string containing a path
  351.                                         of which the object is a trustee.
  352.                                         when all valid paths have been returned
  353.                                         this will contain NULL.
  354.  
  355. --------------------------------------------------------------------------------
  356.  
  357.   ScanProperty (BinderyObjectName : ObjectNameType;
  358.                 BinderyObjectType : OT_BinderyType;
  359.                 SearchPropertyName : PropertyNameType;
  360.                 VAR SequenceNumber : LONGINT;
  361.                 VAR PropertyName : PropertyNameType; VAR PropertyFlags,
  362.                 PropertySecurity, PropertyHasValue,
  363.                 MoreProperties : BYTE) : WORD;
  364.  
  365.     Scans the bindery for an object's properties.
  366.  
  367.     BinderyObjectName (Input)         : name of the object to search.
  368.  
  369.     BinderyObjectType (Input)         : type of the object to search.
  370.  
  371.     SearchPropertyName (Input)        : name of property to search for.
  372.                                         wildcards are allowed.
  373.  
  374.     SequenceNumber (Input/Output)     : contains the sequence number from a
  375.                                         previous search.  Initial search
  376.                                         requires a -1.
  377.  
  378.     PropertyName (Output)             : receives the matching property name.
  379.  
  380.     PropertyFlags (Output)            : indicates whether the property is
  381.                                         DYNAMIC/STATIC and SET/ITEM.
  382.  
  383.     PropertySecurity (Output)         : receives the read/write security of the
  384.                                         matching property.
  385.  
  386.     PropertyHasValue (Output)         : indicates whether the property has a
  387.                                         value. (0 = no value)
  388.                                                (255 = property has value)
  389.  
  390.     MoreProperties (Output)           : indicates whether the object has more
  391.                                         properties. (0 = no more properties)
  392.                                                     (255 = more properties)
  393.  
  394. -------------------------------------------------------------------------------
  395.  
  396.   VerifyBinderyObjectPassword (BinderyObjectName : ObjectNameType;
  397.                                BinderyObjectType : OT_BinderyType;
  398.                                Password : PasswordType) : WORD;
  399.  
  400.     Verifies that the password of a bindery object is valid.
  401.     NOTE : DOES NOT WORK WITH ENCRYPTED PW
  402.  
  403.     BinderyObjectName (Input)         : name of the object to verify.
  404.  
  405.     BinderyObjectType (Input)         : type of the object.
  406.  
  407.     Password (Input)                  : the password that is to be verified.
  408.  
  409. -------------------------------------------------------------------------------
  410.  
  411.   WritePropertyValue (BinderyObjectName : ObjectNameType;
  412.                       BinderyObjectType : OT_BinderyType;
  413.                       PropertyName : PropertyNameType; SegmentNumber : WORD;
  414.                       PropertyValue : PropertyValueType;
  415.                       MoreSegments : BYTE) : WORD;
  416.  
  417.     Writes a value to an item or set property.
  418.  
  419.     BinderyObjectName (Input)         : name of the bindery object.
  420.  
  421.     BinderyObjectType (Input)         : type of the bindery object.
  422.  
  423.     PropertyName (Input)              : name of the property to be written.
  424.  
  425.     SegmentNumber (Input)             : segment number of the property to be
  426.                                         written. (1 = first segment)
  427.  
  428.     PropertyValue (Input)             : contains the buffer to be written.
  429.  
  430.     MoreSegments (Input)              : indicates if the property value has more
  431.                                         segments to follow.
  432.                                         (0 = no more segments)
  433.                                         (255 = more segments follow)
  434.  
  435. -------------------------------------------------------------------------------
  436.